Fix writing-tests.md reference to enable_factory_create #234

yoomlam · 2024-07-16T23:37:02Z

Ticket

Small documentation correction to be consistent with code.

Changes

template-application-flask/docs/app/writing-tests.md

Line 84 in dded29c

In order to use the create strategy, pull in the `initialize_factories_session`

refers to initialize_factories_session but should be enable_factory_create

Testing

Compare with

template-application-flask/docs/app/database/database-testing.md

Line 13 in dded29c

    
           The application uses [Factory Boy](https://factoryboy.readthedocs.io/en/stable/) to generate test data for the application. This can be used to create models `Factory.build` that can be used in any test, or to prepopulate the database with persisted models using `Factory.create`. In order to use `Factory.create` to create persisted database models, include the `enable_factory_create` fixture in the test.

and

template-application-flask/app/tests/conftest.py

Lines 98 to 105 in dded29c

    
           def enable_factory_create(monkeypatch, db_session) -> db.Session: 
        
               """ 
        
               Allows the create method of factories to be called. By default, the create 
        
               throws an exception to prevent accidental creation of database objects for tests 
        
               that do not need persistence. This fixture only allows the create method to be 
        
               called for the current test. Each test that needs to call Factory.create should pull in 
        
               this fixture. 
        
               """

Fix writing-tests.md reference to enable_factory_create

e2dc37c

yoomlam requested a review from chouinar July 16, 2024 23:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix writing-tests.md reference to enable_factory_create #234

Fix writing-tests.md reference to enable_factory_create #234

yoomlam commented Jul 16, 2024

	def enable_factory_create(monkeypatch, db_session) -> db.Session:
	"""
	Allows the create method of factories to be called. By default, the create
	throws an exception to prevent accidental creation of database objects for tests
	that do not need persistence. This fixture only allows the create method to be
	called for the current test. Each test that needs to call Factory.create should pull in
	this fixture.
	"""

Fix writing-tests.md reference to enable_factory_create #234

Are you sure you want to change the base?

Fix writing-tests.md reference to enable_factory_create #234

Conversation

yoomlam commented Jul 16, 2024

Ticket

Changes

Testing